@pluginjs/keyboard
Advanced tools
keyboard is a utility JavaScript library for keyboard event.
yarn add @pluginjs/keyboard
npm i @pluginjs/keyboard
CDN:
Development:
<script src="https://unpkg.com/@pluginjs/keyboard/dist/keyboard.js"></script>
Production:
<script src="https://unpkg.com/@pluginjs/keyboard/dist/keyboard.min.js"></script>
mount keydown keyup event listener on this.element.
Parameters
| Name | Type | Description |
|||-|
| e | Event | |
Parameters
| Name | Type | Description |
|||-|
| action | String | |
| key | String | |
| func | Function | |
Returns
| Name | Type | Description |
|||-|
| instance | Object | this |
Parameters
| Name | Type | Description |
|||-|
| action | String | |
| key | String | |
| func | Function | |
Returns
| Name | Type | Description |
|||-|
| instance | Object | this |
Parameters
| Name | Type | Description |
|||-|
| toggle | Boolean | |
| action | String | |
| key | String | |
| func | Function | |
Returns
| Name | Type | Description |
|||-|
| instance | Object | this |
Parameters
| Name | Type | Description |
|||-|
| keys | String[] | |
Returns
| Name | Type | Description |
|||-|
| newKeys | String[] | |
Parameters
| Name | Type | Description |
|||-|
| key | String | |
Returns
| Name | Type | Description |
|||-|
| newKeys | String[] | |
Parameters
| Name | Type | Description |
|||-|
| key | String | |
Returns
| Name | Type | Description |
|||-|
| modifiers | Function[] | |
Parameters
| Name | Type | Description |
|||-|
| action | String | |
| key | String | |
| func | Function | |
Returns
| Name | Type | Description |
|||-|
| instance | Object | this |
Parameters
| Name | Type | Description |
|||-|
| keyCode | String | |
Returns
| Name | Type | Description |
|||-|
| keyName | String | |
Parameters
| Name | Type | Description |
|||-|
| keyName | String | |
Returns
| Name | Type | Description |
|||-|
| keyCode | String | |
Parameters
| Name | Type | Description |
|||-|
| key | String | |
| func | Function | |
Returns
| Name | Type | Description |
|||-|
| instance | Object | this |
Parameters
| Name | Type | Description |
|||-|
| key | String | |
| func | Function | |
Returns
| Name | Type | Description |
|||-|
| instance | Object | this |
Tested on all major browsers.
 IE / Edge |  Firefox |  Chrome |  Safari |  Opera |
|---|---|---|---|---|
| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
@pluginjs/keyboard is Licensed under the GPL-v3 license.
If you want to use @pluginjs/keyboard project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.
For purchase an Commercial License, contact us purchase@thecreation.co.
Copyright (C) 2018 Creation Studio Limited.
FAQs
A workflow for modern frontend development.
The npm package @pluginjs/keyboard receives a total of 6 weekly downloads. As such, @pluginjs/keyboard popularity was classified as not popular.
We found that @pluginjs/keyboard demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.